Product: Word Links by BOP5

Official Mod Threads: 
VB 4.x - http://www.vbulletin.org/forum/misc.php?do=producthelp&pid=wordlinkbop5vb4
VB 3,x - http://www.vbulletin.org/forum/misc.php?do=producthelp&pid=wordlinkbop5

Developer: BirdOPrey5 on vBulletin.org

Profile URL: http://www.vbulletin.org/forum/member.php?u=258922

Demo: http://www.juot.net/forums/showthread.php?t=58948

Version 1.5
Thus product is now at release 1.0 status agfter several weeks of beta testing!

The purpose of this product is to automatically turn words or phrases on your forum into links. Usually this is used to link to affiliate sites or SEO purposes. This can also be used for internal linking such linking "Forum Rules" to your forum's rules, I'm assuming you have a reason to use it if you've come this far.

The mod allows you to turn words or phrases into links in all forums or selected forums, in visitor messages, and/or social groups. You can choose some or all of these in the mod options.

Basically you enter a list of keywords (or phrases) you want to turn into links in one box, and in the next box you enter the URL for each corresponding keyword. Blank lines are ignored but the links and keywords must be in order- the first link will correspond to the first keyword and so on. New as of version 1.5, you can now read keywords and URLs from a data file if you prefer.

If a keyword or phrase contains a sub-string of another keyword, the longer keyword must be listed first. For example you'd enter the following keywords in this order:

Jeep Grand Cherokee
Grand Cherokee
Cherokee
Jeep

The first option after enable is the filename of a data file. This data file must be csv format. See the file "How to use a Data File" for more details. If you do not want to use a data file than make sure this box is completely blank.


You can choose if the links will base case sensitive. If Yes only words that exactly match the case you specify will be linked. Most people will keep this set to No. 

You can choose whether you want to link whole words only or not. If you link to whole words only assuming "Jeep" is a keyword it will only turn "jeep" into a link (capitalization is ignored). It will NOT turn "jeeps" into a link. 

You can choose the maximum number of links generated per keyword per post or maximum number of links per page. (SHOWTHREAD / Social Group Page / Visitor Message Page.)

You can choose if rel="nofollow" is included in the links created by this mod. If you don't know what this means just leave it turned off (by default.)

You can choose to open the links created in a new window or tab of your browser or not. If not it will open in the same window so users will leave your forum by clicking on the link.

You can also choose to disable the links for any usergroups you choose. Enter the usergroupids in the specified box.Users in these groups (primary or secondary) will not see these links. 

You can choose what forums to be active in. You can choose to activate in Social Groups, Visitor Messages, and PMs too.

You can choose to display a custom notice in posts, PMs, visitor messages, and social group posts to alert users that keywords have automatically been turned into links.

To edit this notice use the Phrase Manager and edit the GLOBAL phrase: bop5_wordlinks_note.
HTML code is allowed in phrases. {1} will be replaced with the number of keywords linked in a post. Its use in the phrase is optional.

You can create a custom "User Profile Field" and activate it to allow users to turn off automatic word linking. If you choose to do this you must create a custom profile field with these EXACT options- capitalization counts.

In Admin CP go to User Profile Field -> Add New User Profile Field.

Profile Field Type: Single-Selection Radio Buttons.

Title: Automatic Word Linking (you can call it what you want)
Description: If turned on some keywords will automatically be turned into links. (you can edit this too)
Profile Field Category: Leave as is
Items Per Line: 0
Options: (Must be entered EXACTLY as below - see screen shot)
On
Off
Set Default: Yes
Display Order: Up to you
Field Editable by User: Yes
Private Field: No
Field Searchable on Members List: No
Show on Members List: No

Leave everything else as is except the last option, Which page displays this option? I suggest "Thread Display Options" but up to you.

Save the new profile field and you will see the field number on the Profile Field Manager page. Note the field number. Note this may not be the same as the display order. You want the number after the word "field" - such as "field5" - then enter 5 into the mod setting to activate this feature. 

*****IMPORTANT******
You should always BACKUP your Database before installing a new mod. I have tested this but can't be responsible if something goes wrong. This is provided AS IS, USE AT YOUR OWN RISK. I will provide support as I am able. 

You can get support for this mod at the mod thread on vBulletin.org (you will find it on my profile page above) OR you can ask for help on my personal forum, Joe's Ultimate Off Topic (http://www.juot.net) in my Forum Suggestions, Help, and Tech Support forum.

*****Install / Upgrade Instructions******

To Install: 
In Admin CP go to Plugins & Products -> Manage Products -> Add/Import Product
Click on "Choose File" and browse to the product xml file that was packaged in the .zip file.
Click "Import"

To Upgrade:
In Admin CP go to Plugins & Products -> Manage Products -> Add/Import Product
Click on "Choose File" and browse to the product xml file that was packaged in the .zip file.
Change "Allow Overwrite" to YES
Click "Import"

You must go to Product Options to setup and enable the product.

-----
**** Customize Links with CSS ****

As of version 0.94 the below is now optional based on the "Enable CSS?" setting in the mod.

As of version 0.92 all links created are within a <span> tag of class "boplink." This allows you to customize the look of the links created by this mod ussing CSS.

In your "Additional CSS" you can add the following CSS code and customize it to your liking for each of your styles. This is OPTIONAL. If you do not add this CSS links will retain the same style as existing links in your posts.

Sample CSS:

.boplink A:link {background: yellow; text-decoration: none}
.boplink A:visited {background: yellow; text-decoration: none}
.boplink A:active {background: yellow; text-decoration: none}
.boplink A:hover {background: yellow; font-weight:bold; color: red;}

This CSS will highlight the links in yellow and turn the text to red and bold when mouse-overed.

In VB 3.x Additional CSS is accessible via Style Manger -> All Style Options, scroll down to Additional CSS Definitions. Use the lower box to customize the CSS uniquely for each style. 
In VB 4.x edit the CSS template additional.css and add the code there.  

----
There are two versions of this mod, one for vBulletin 3.x and one for vBulletin 4.x. You will only be able to install the correct version for your forum.

The VB3 version has been tested on 3.8.7 and 3.8.6 and will work on all 3.8 versions. It will work on earlier versions with limited functionality since social groups and visitor messaging isn't available in earlier versions. 

The VB4 version has been tested on 4.0.8 and should work on all 4.0.x and 4.1.x releases and probably all future 4.x versions as well.
